<!DOCTYPE html>
<html>
  <head>
    <meta charset='utf-8'>
    <meta content='width=device-width, initial-scale=1.0' name='viewport'>
    <meta content='' name='description'>
    <meta content='Nils Nordman' name='author'>
    <link href='/images/howl.png' rel='shortcut icon'>
    <title>Howl :: Spec - howl.Clipboard</title>
    <link href="/stylesheets/bootstrap.min.css" media="screen" rel="stylesheet" type="text/css" />
    <link href="/stylesheets/syntax.css" media="screen" rel="stylesheet" type="text/css" />
    <link href="/stylesheets/howl.css" media="screen" rel="stylesheet" type="text/css" />
    <link href='//fonts.googleapis.com/css?family=Josefin+Slab' rel='stylesheet' type='text/css'>
    <link href='//fonts.googleapis.com/css?family=Open+Sans+Condensed:700' rel='stylesheet' type='text/css'>
  </head>
  <body class='doc doc_spec doc_spec_clipboard_spec'>
    <div class='container'>
      <div class='masthead'>
        <ul class='nav nav-pills'>
          <li>
            <a href='/'>
              <span class='glyphicon glyphicon-home'></span>
              Home
            </a>
          </li>
          <li>
            <a href='/doc/'>
              <span class='glyphicon glyphicon-book'></span>
              Documentation
            </a>
          </li>
          <li>
            <a href='/blog/'>
              <span class='glyphicon glyphicon-bullhorn'></span>
              Blog
            </a>
          </li>
          <li>
            <a href='/contact.html'>
              <span class='glyphicon glyphicon-inbox'></span>
              Contact
            </a>
          </li>
        </ul>
      </div>
      <ol class="breadcrumb"><li><a href="/">Home</a></li><li><a href='../'>Howl 0.3 Documentation</a></li><li>Spec</li><li>Spec - howl.Clipboard</li></ol>
      <div class="spec-group spec-group-1">&#x000A;&#x000A;<h1 id="howl.clipboard">howl.Clipboard</h1>&#x000A;&#x000A;<pre class="highlight moonscript"><code><span class="n">system_cb</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nc">GtkClipboard</span><span class="p">.</span><span class="n">get</span><span class="p">(</span><span class="nc">Atom</span><span class="p">.</span><span class="nc">SELECTION_CLIPBOARD</span><span class="p">)</span><span class="w">&#x000A;&#x000A;</span><span class="n">before_each</span><span class="w"> </span><span class="o">-&gt;</span><span class="w">  </span><span class="n">clipboard</span><span class="p">.</span><span class="n">clear</span><span class="o">!</span></code></pre>&#x000A;&#x000A;<div class="spec-group spec-group-2">&#x000A;&#x000A;<h2 id="push">push<span class="arg-list">(item, opts = {})</span></h2>&#x000A;<div class="spec-group spec-group-3">&#x000A;&#x000A;<h3 id=""><span class="arg-list">(when &lt;item&gt; is a string)</span></h3>&#x000A;&#x000A;<h4 id="adds-a-clip-item-containing-text-to-the-clipboard">adds a clip item containing text to the clipboard</h4>&#x000A;&#x000A;<pre class="highlight moonscript"><code><span class="n">clipboard</span><span class="p">.</span><span class="n">push</span><span class="w"> </span><span class="s1">'hello!'</span><span class="w">&#x000A;</span><span class="n">assert</span><span class="p">.</span><span class="n">equals</span><span class="w"> </span><span class="s1">'hello!'</span><span class="p">,</span><span class="w"> </span><span class="n">clipboard</span><span class="p">.</span><span class="n">current</span><span class="p">.</span><span class="n">text</span></code></pre>&#x000A;&#x000A;</div>&#x000A;<div class="spec-group spec-group-3">&#x000A;&#x000A;<h3 id=""><span class="arg-list">(when &lt;item&gt; is a table)</span></h3>&#x000A;&#x000A;<h4 id="adds-the-clip-item-as-is-to-the-clipboard">adds the clip item as is to the clipboard</h4>&#x000A;&#x000A;<pre class="highlight moonscript"><code><span class="n">clipboard</span><span class="p">.</span><span class="n">push</span><span class="w"> </span><span class="ss">text:</span><span class="w"> </span><span class="s1">'hello!'</span><span class="w">&#x000A;</span><span class="n">assert</span><span class="p">.</span><span class="n">equals</span><span class="w"> </span><span class="s1">'hello!'</span><span class="p">,</span><span class="w"> </span><span class="n">clipboard</span><span class="p">.</span><span class="n">current</span><span class="p">.</span><span class="n">text</span></code></pre>&#x000A;&#x000A;&#x000A;<h4 id="raises-an-error-if-&lt;item&gt;-has-no-.text-field">raises an error if &lt;item&gt; has no .text field</h4>&#x000A;&#x000A;<pre class="highlight moonscript"><code><span class="n">assert</span><span class="p">.</span><span class="n">raises</span><span class="w"> </span><span class="s1">'text'</span><span class="p">,</span><span class="w"> </span><span class="o">-&gt;</span><span class="w"> </span><span class="n">clipboard</span><span class="p">.</span><span class="n">push</span><span class="w"> </span><span class="p">{}</span></code></pre>&#x000A;&#x000A;</div>&#x000A;<div class="spec-group spec-group-3">&#x000A;&#x000A;<h3 id=""><span class="arg-list">(when opts contains a &quot;.to&quot; field)</span></h3>&#x000A;&#x000A;<h4 id="pushes-the-item-to-the-specified-target">pushes the item to the specified target</h4>&#x000A;&#x000A;<pre class="highlight moonscript"><code><span class="n">clipboard</span><span class="p">.</span><span class="n">push</span><span class="w"> </span><span class="s1">'hello!'</span><span class="p">,</span><span class="w"> </span><span class="ss">to:</span><span class="w"> </span><span class="s1">'a'</span><span class="w">&#x000A;</span><span class="n">assert</span><span class="p">.</span><span class="n">is_nil</span><span class="w"> </span><span class="n">clipboard</span><span class="p">.</span><span class="n">current</span><span class="w">&#x000A;</span><span class="n">assert</span><span class="p">.</span><span class="n">equals</span><span class="w"> </span><span class="s1">'hello!'</span><span class="p">,</span><span class="w"> </span><span class="n">clipboard</span><span class="p">.</span><span class="n">registers</span><span class="p">.</span><span class="n">a</span><span class="p">.</span><span class="n">text</span></code></pre>&#x000A;&#x000A;</div>&#x000A;<div class="spec-group spec-group-3">&#x000A;&#x000A;<h3 id=""><span class="arg-list">(when no &quot;.to&quot; field is specified in opts)</span></h3>&#x000A;&#x000A;<h4 id="ensures-the-number-of-clips-does-not-exceed-config.clipboard_max_items">ensures the number of clips does not exceed config.clipboard_max_items</h4>&#x000A;&#x000A;<pre class="highlight moonscript"><code><span class="n">config</span><span class="p">.</span><span class="n">clipboard_max_items</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">5</span><span class="w">&#x000A;</span><span class="k">for</span><span class="w"> </span><span class="n">i</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="mi">6</span><span class="w">&#x000A;  </span><span class="n">clipboard</span><span class="p">.</span><span class="n">push</span><span class="w"> </span><span class="s2">"clip </span><span class="si">#{</span><span class="n">i</span><span class="si">}</span><span class="s2">"</span><span class="w">&#x000A;&#x000A;</span><span class="n">assert</span><span class="p">.</span><span class="n">equals</span><span class="w"> </span><span class="mi">5</span><span class="p">,</span><span class="w"> </span><span class="o">#</span><span class="n">clipboard</span><span class="p">.</span><span class="n">clips</span><span class="w">&#x000A;</span><span class="n">assert</span><span class="p">.</span><span class="n">equals</span><span class="w"> </span><span class="s1">'clip 6'</span><span class="p">,</span><span class="w"> </span><span class="n">clipboard</span><span class="p">.</span><span class="n">clips</span><span class="p">[</span><span class="mi">1</span><span class="p">].</span><span class="n">text</span><span class="w">&#x000A;</span><span class="n">assert</span><span class="p">.</span><span class="n">equals</span><span class="w"> </span><span class="s1">'clip 2'</span><span class="p">,</span><span class="w"> </span><span class="n">clipboard</span><span class="p">.</span><span class="n">clips</span><span class="p">[</span><span class="mi">5</span><span class="p">].</span><span class="n">text</span></code></pre>&#x000A;&#x000A;&#x000A;<h4 id="copies-the-clip-to-the-system-clipboard-as-well">copies the clip to the system clipboard as well</h4>&#x000A;&#x000A;<pre class="highlight moonscript"><code><span class="n">clipboard</span><span class="p">.</span><span class="n">push</span><span class="w"> </span><span class="s1">'global!'</span><span class="w">&#x000A;</span><span class="n">assert</span><span class="p">.</span><span class="n">equals</span><span class="w"> </span><span class="s1">'global!'</span><span class="p">,</span><span class="w"> </span><span class="n">system_cb</span><span class="o">\</span><span class="n">wait_for_text</span><span class="o">!</span></code></pre>&#x000A;&#x000A;</div>&#x000A;</div>&#x000A;<div class="spec-group spec-group-2">&#x000A;&#x000A;<h2 id="clear">clear<span class="arg-list">()</span></h2>&#x000A;&#x000A;<h4 id="clears-all-clips">clears all clips</h4>&#x000A;&#x000A;<pre class="highlight moonscript"><code><span class="n">clipboard</span><span class="p">.</span><span class="n">push</span><span class="w"> </span><span class="s1">'hello!'</span><span class="w">&#x000A;</span><span class="n">clipboard</span><span class="p">.</span><span class="n">push</span><span class="w"> </span><span class="s1">'to register!'</span><span class="p">,</span><span class="w"> </span><span class="ss">to:</span><span class="w"> </span><span class="s1">'a'</span><span class="w">&#x000A;</span><span class="n">clipboard</span><span class="p">.</span><span class="n">clear</span><span class="o">!</span><span class="w">&#x000A;</span><span class="n">assert</span><span class="p">.</span><span class="n">is_nil</span><span class="w"> </span><span class="n">clipboard</span><span class="p">.</span><span class="n">current</span><span class="w">&#x000A;</span><span class="n">assert</span><span class="p">.</span><span class="n">is_nil</span><span class="w"> </span><span class="n">clipboard</span><span class="p">.</span><span class="n">registers</span><span class="p">.</span><span class="n">a</span></code></pre>&#x000A;&#x000A;</div>&#x000A;<div class="spec-group spec-group-2">&#x000A;&#x000A;<h2 id="synchronize">synchronize<span class="arg-list">()</span></h2>&#x000A;&#x000A;<h4 id="adds-the-clip-from-the-system-clipboard-if-it-differs-from-.current">adds the clip from the system clipboard if it differs from .current</h4>&#x000A;&#x000A;<pre class="highlight moonscript"><code><span class="n">system_cb</span><span class="o">\</span><span class="n">set_text</span><span class="w"> </span><span class="s1">'pushed'</span><span class="w">&#x000A;</span><span class="n">clipboard</span><span class="p">.</span><span class="n">synchronize</span><span class="o">!</span><span class="w">&#x000A;</span><span class="n">assert</span><span class="p">.</span><span class="n">equals</span><span class="w"> </span><span class="s1">'pushed'</span><span class="p">,</span><span class="w"> </span><span class="n">clipboard</span><span class="p">.</span><span class="n">current</span><span class="p">.</span><span class="n">text</span></code></pre>&#x000A;&#x000A;&#x000A;<h4 id="does-nothing-if-the-texts-are-the-same">does nothing if the texts are the same</h4>&#x000A;&#x000A;<pre class="highlight moonscript"><code><span class="n">clipboard</span><span class="p">.</span><span class="n">push</span><span class="w"> </span><span class="s1">'pushed'</span><span class="w">&#x000A;</span><span class="n">system_cb</span><span class="o">\</span><span class="n">set_text</span><span class="w"> </span><span class="s1">'pushed'</span><span class="w">&#x000A;</span><span class="n">clipboard</span><span class="p">.</span><span class="n">synchronize</span><span class="o">!</span><span class="w">&#x000A;</span><span class="n">assert</span><span class="p">.</span><span class="n">equals</span><span class="w"> </span><span class="s1">'pushed'</span><span class="p">,</span><span class="w"> </span><span class="n">clipboard</span><span class="p">.</span><span class="n">current</span><span class="p">.</span><span class="n">text</span><span class="w">&#x000A;</span><span class="n">assert</span><span class="p">.</span><span class="n">equals</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w"> </span><span class="o">#</span><span class="n">clipboard</span><span class="p">.</span><span class="n">clips</span></code></pre>&#x000A;&#x000A;</div>&#x000A;</div>
      <div class='footer text-muted'>
        <a href='/'>
          <img width="50" height="50" class="footer-logo" src="/images/howl.png" />
        </a>
        <div class='footer-follow'>
          <p>
            <a class='twitter-follow-button' data-lang='en' data-show-count='false' href='https://twitter.com/howleditor' rel='me'>
              Follow @howleditor
            </a>
          </p>
          <p>
            <a class='twitter-share-button' data-count='none' data-hashtags='howleditor' data-lang='en' data-text='The Howl Editor, a general purpose, light-weight customizable editor.' data-url='http://howl.io' href='https://twitter.com/share'>
              Tweet
            </a>
          </p>
        </div>
        <div class='footer-blurb'>
          <div>The Howl editor.</div>
          <div>
            Copyright 2012-2015
            <a class='alert-link' href='https://github.com/nilnor/howl/contributors'>
              The Howl Developers.
            </a>
          </div>
        </div>
      </div>
    </div>
    <script>
      <!-- / GA -->
      (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
      (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
      m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
      })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
      ga('create', 'UA-45283282-1', 'howl.io');
      ga('send', 'pageview');
      <!-- / Twitter -->
      !function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0];
      if(!d.getElementById(id)){js=d.createElement(s);js.id=id;
      js.src="//platform.twitter.com/widgets.js";
      fjs.parentNode.insertBefore(js,fjs);}}(document,"script","twitter-wjs");
    </script>
  </body>
</html>
